CASI API - Errors

Returns a list of validation warnings for a specific scheme that are of the chosen ObjectType.

Path Parameters

Parameter	Description
scheme	Scheme ID number

Errors GET

Returns a list of validation warnings for a specific scheme that are of the chosen ObjectType.
The user can also specify a certifier GUID and/or filter class name to narrow the results.

Parameters

Request Parameters

Parameter	Name	Type	Description
certifierguid	Certifier GUID	String (Optional)	Certifier GUID to check results for
filterclass	Filter Class	String (Optional)	Filter class to retrieve warnings for
type	Type	Enumeration	Object type to retrieve information for

Response Parameters

Parameter	Name	Type	Description
errors	Errors	List	Detailed warning information related to this error.
filterclass	Filter Class	String (Optional)
filtername	Filter Name	String (Optional)
errorid	ErrorID	Number (Optional)
error	Error	String (Optional)
level	Warning Level	Enumeration (Optional)
type	Type	Enumeration (Optional)
field	Field	Enumeration (Optional)
message	Message	String (Optional)	Error description
linkedkey	Linked Key	String (Optional)
objectid	ObjectID	String (Optional)
memberships		List (Optional)	Membership information for the error reported (if available)
linkedkey	Linked Key	String (Optional)
objectid	ObjectID	String (Optional)
membershipno	Membership No	String (Optional)
primarysitename	Primary Site Name	String (Optional)
status	Membership Status	Enumeration (Optional)
firstreported	First Reported	String (Optional)	Date this error was first reported

Enumerations

Type (Request)

Value	Description
	Please select an object type...
8	Membership
10	Person
11	Assessment
12	Response
13	Certificate
14	NonConformance
9	Site

Warning Level (Response)

Value	Description
0	0
1	1
2	2
3	3
4	4

Type (Response)

Value	Description
Membership	Membership
Person	Person
Assessment	Assessment
Response	Response
Certificate	Certificate
NonConformance	NonConformance
Site	Site

Field (Response)

Value	Description
Transformation	Transformation
Address	Address
Answer	Answer
AssessedObject	AssessedObject
Assessment	Assessment
Assessments	Assessments
AssessmentDate	AssessmentDate
Certificates	Certificates
Certifier	Certifier
Company	Company
Contacts	Contacts
CreateDate	CreateDate
Description	Description
EMail	EMail
EndDate	EndDate
Enterprises	Enterprises
Fax	Fax
Firstname	Firstname
Free1	Free1
Free2	Free2
Free3	Free3
GUID	GUID
HoldingNumber	HoldingNumber
ID	ID
Initials	Initials
LocalID	LocalID
Membership	Membership
Mobile	Mobile
ModifiedDate	ModifiedDate
Name	Name
Number	Number
Point	Point
Postcode	Postcode
PreviousCertifier	PreviousCertifier
PreviousNumber	PreviousNumber
PrimaryContact	PrimaryContact
PrimarySite	PrimarySite
QCDate	QCDate
Scope	Scope
Score	Score
Sites	Sites
StartDate	StartDate
Status	Status
StatusDate	StatusDate
Surname	Surname
Telephone	Telephone
Title	Title
URL	URL
Value	Value
HerdMark	HerdMark
Country	Country
State	State
Class	Class
AdditionalData	AdditionalData
Responses	Responses
Destination	Destination
Identifiers	Identifiers
IdentifierType	IdentifierType
LastMovement	LastMovement
Movement	Movement
Static	Static
Reference	Reference
Site	Site
Size	Size
Source	Source
ResolutionDate	ResolutionDate
PrimaryEvidence	PrimaryEvidence
SecondaryEvidence	SecondaryEvidence
Identifier	Identifier
StatementType	StatementType
ChecklistItems	ChecklistItems
Inspector	Inspector

Membership Status (Response)

Value	Description
Current	Current
Reopened	Reopened
TransferredOut	TransferredOut
Closed	Closed
Registered	Registered
Applied	Applied
Provisional	Provisional
Expired	Expired
Grace	Grace
TransferredIn	TransferredIn
Orphaned	Orphaned

XML

Example Request

GET https://api.casi.services/v1/schemes/{scheme}/validation/byobjecttype.eb?certifierguid=String&filterclass=String&type=String HTTP/1.1
Accept: text/xml

Response Schema

<?xml version="1.0" encoding="utf-8"?>
<xsd:schema elementFormDefault="qualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <xsd:element name="ErrorTypeResponse">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="errors">
          <xsd:annotation>
            <xsd:documentation>Detailed warning information related to this error.</xsd:documentation>
          </xsd:annotation>
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="item" minOccurs="0" maxOccurs="unbounded">
                <xsd:complexType>
                  <xsd:sequence>
                    <xsd:element name="filterclass" minOccurs="0" type="xsd:string" />
                    <xsd:element name="filtername" minOccurs="0" type="xsd:string" />
                    <xsd:element name="errorid" minOccurs="0" type="xsd:double" />
                    <xsd:element name="error" minOccurs="0" type="xsd:string" />
                    <xsd:element name="level" minOccurs="0">
                      <xsd:simpleType>
                        <xsd:restriction base="xsd:string">
                          <xsd:enumeration value="0" />
                          <xsd:enumeration value="1" />
                          <xsd:enumeration value="2" />
                          <xsd:enumeration value="3" />
                          <xsd:enumeration value="4" />
                        </xsd:restriction>
                      </xsd:simpleType>
                    </xsd:element>
                    <xsd:element name="type" minOccurs="0">
                      <xsd:simpleType>
                        <xsd:restriction base="xsd:string">
                          <xsd:enumeration value="Membership" />
                          <xsd:enumeration value="Person" />
                          <xsd:enumeration value="Assessment" />
                          <xsd:enumeration value="Response" />
                          <xsd:enumeration value="Certificate" />
                          <xsd:enumeration value="NonConformance" />
                          <xsd:enumeration value="Site" />
                        </xsd:restriction>
                      </xsd:simpleType>
                    </xsd:element>
                    <xsd:element name="field" minOccurs="0">
                      <xsd:simpleType>
                        <xsd:restriction base="xsd:string">
                          <xsd:enumeration value="Transformation" />
                          <xsd:enumeration value="Address" />
                          <xsd:enumeration value="Answer" />
                          <xsd:enumeration value="AssessedObject" />
                          <xsd:enumeration value="Assessment" />
                          <xsd:enumeration value="Assessments" />
                          <xsd:enumeration value="AssessmentDate" />
                          <xsd:enumeration value="Certificates" />
                          <xsd:enumeration value="Certifier" />
                          <xsd:enumeration value="Company" />
                          <xsd:enumeration value="Contacts" />
                          <xsd:enumeration value="CreateDate" />
                          <xsd:enumeration value="Description" />
                          <xsd:enumeration value="EMail" />
                          <xsd:enumeration value="EndDate" />
                          <xsd:enumeration value="Enterprises" />
                          <xsd:enumeration value="Fax" />
                          <xsd:enumeration value="Firstname" />
                          <xsd:enumeration value="Free1" />
                          <xsd:enumeration value="Free2" />
                          <xsd:enumeration value="Free3" />
                          <xsd:enumeration value="GUID" />
                          <xsd:enumeration value="HoldingNumber" />
                          <xsd:enumeration value="ID" />
                          <xsd:enumeration value="Initials" />
                          <xsd:enumeration value="LocalID" />
                          <xsd:enumeration value="Membership" />
                          <xsd:enumeration value="Mobile" />
                          <xsd:enumeration value="ModifiedDate" />
                          <xsd:enumeration value="Name" />
                          <xsd:enumeration value="Number" />
                          <xsd:enumeration value="Point" />
                          <xsd:enumeration value="Postcode" />
                          <xsd:enumeration value="PreviousCertifier" />
                          <xsd:enumeration value="PreviousNumber" />
                          <xsd:enumeration value="PrimaryContact" />
                          <xsd:enumeration value="PrimarySite" />
                          <xsd:enumeration value="QCDate" />
                          <xsd:enumeration value="Scope" />
                          <xsd:enumeration value="Score" />
                          <xsd:enumeration value="Sites" />
                          <xsd:enumeration value="StartDate" />
                          <xsd:enumeration value="Status" />
                          <xsd:enumeration value="StatusDate" />
                          <xsd:enumeration value="Surname" />
                          <xsd:enumeration value="Telephone" />
                          <xsd:enumeration value="Title" />
                          <xsd:enumeration value="URL" />
                          <xsd:enumeration value="Value" />
                          <xsd:enumeration value="HerdMark" />
                          <xsd:enumeration value="Country" />
                          <xsd:enumeration value="State" />
                          <xsd:enumeration value="Class" />
                          <xsd:enumeration value="AdditionalData" />
                          <xsd:enumeration value="Responses" />
                          <xsd:enumeration value="Destination" />
                          <xsd:enumeration value="Identifiers" />
                          <xsd:enumeration value="IdentifierType" />
                          <xsd:enumeration value="LastMovement" />
                          <xsd:enumeration value="Movement" />
                          <xsd:enumeration value="Static" />
                          <xsd:enumeration value="Reference" />
                          <xsd:enumeration value="Site" />
                          <xsd:enumeration value="Size" />
                          <xsd:enumeration value="Source" />
                          <xsd:enumeration value="ResolutionDate" />
                          <xsd:enumeration value="PrimaryEvidence" />
                          <xsd:enumeration value="SecondaryEvidence" />
                          <xsd:enumeration value="Identifier" />
                          <xsd:enumeration value="StatementType" />
                          <xsd:enumeration value="ChecklistItems" />
                          <xsd:enumeration value="Inspector" />
                        </xsd:restriction>
                      </xsd:simpleType>
                    </xsd:element>
                    <xsd:element name="message" minOccurs="0" type="xsd:string">
                      <xsd:annotation>
                        <xsd:documentation>Error description</xsd:documentation>
                      </xsd:annotation>
                    </xsd:element>
                    <xsd:element name="linkedkey" minOccurs="0" type="xsd:string" />
                    <xsd:element name="objectid" minOccurs="0" type="xsd:string" />
                    <xsd:element name="memberships" minOccurs="0">
                      <xsd:annotation>
                        <xsd:documentation>Membership information for the error reported (if available)</xsd:documentation>
                      </xsd:annotation>
                      <xsd:complexType>
                        <xsd:sequence>
                          <xsd:element name="item" minOccurs="0" maxOccurs="unbounded">
                            <xsd:complexType>
                              <xsd:sequence>
                                <xsd:element name="linkedkey" minOccurs="0" type="xsd:string" />
                                <xsd:element name="objectid" minOccurs="0" type="xsd:string" />
                                <xsd:element name="membershipno" minOccurs="0" type="xsd:string" />
                                <xsd:element name="primarysitename" minOccurs="0" type="xsd:string" />
                                <xsd:element name="status" minOccurs="0">
                                  <xsd:simpleType>
                                    <xsd:restriction base="xsd:string">
                                      <xsd:enumeration value="Current" />
                                      <xsd:enumeration value="Reopened" />
                                      <xsd:enumeration value="TransferredOut" />
                                      <xsd:enumeration value="Closed" />
                                      <xsd:enumeration value="Registered" />
                                      <xsd:enumeration value="Applied" />
                                      <xsd:enumeration value="Provisional" />
                                      <xsd:enumeration value="Expired" />
                                      <xsd:enumeration value="Grace" />
                                      <xsd:enumeration value="TransferredIn" />
                                      <xsd:enumeration value="Orphaned" />
                                    </xsd:restriction>
                                  </xsd:simpleType>
                                </xsd:element>
                              </xsd:sequence>
                            </xsd:complexType>
                          </xsd:element>
                        </xsd:sequence>
                      </xsd:complexType>
                    </xsd:element>
                    <xsd:element name="firstreported" minOccurs="0" type="xsd:string">
                      <xsd:annotation>
                        <xsd:documentation>Date this error was first reported</xsd:documentation>
                      </xsd:annotation>
                    </xsd:element>
                  </xsd:sequence>
                </xsd:complexType>
              </xsd:element>
            </xsd:sequence>
          </xsd:complexType>
        </xsd:element>
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>
</xsd:schema>

Example Response

HTTP/1.1 200 OK
Content-Type: text/xml

<?xml version="1.0" encoding="utf-8"?>
<ErrorTypeResponse>
  <errors>
    <item>
      <filterclass>xsd:string</filterclass>
      <filtername>xsd:string</filtername>
      <errorid>xsd:double</errorid>
      <error>xsd:string</error>
      <level>xsd:string</level>
      <type>xsd:string</type>
      <field>xsd:string</field>
      <message>xsd:string</message>
      <linkedkey>xsd:string</linkedkey>
      <objectid>xsd:string</objectid>
      <memberships>
        <item>
          <linkedkey>xsd:string</linkedkey>
          <objectid>xsd:string</objectid>
          <membershipno>xsd:string</membershipno>
          <primarysitename>xsd:string</primarysitename>
          <status>xsd:string</status>
        </item>...</memberships>
      <firstreported>xsd:string</firstreported>
    </item>...</errors>
</ErrorTypeResponse>

Download full schema

JSON

Example Request

GET https://api.casi.services/v1/schemes/{scheme}/validation/byobjecttype.eb?certifierguid=String&filterclass=String&type=String HTTP/1.1
Accept: application/json

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{"errors":[{"filterclass":String,
      "filtername":String,
      "errorid":Number,
      "error":String,
      "level":String,
      "type":String,
      "field":String,
      "message":String,
      "linkedkey":String,
      "objectid":String,
      "memberships":[{"linkedkey":String,
          "objectid":String,
          "membershipno":String,
          "primarysitename":String,
          "status":String},
        ...],
      "firstreported":String},
    ...]}

Status Codes

Status and Error Codes

HTTP Status	Error Code	Description
400	DataError:type:RequiredRule	Type is required.

The list that is returned by this API will depend on the persona of the user that is currently logged in. Administrators and managers have full access to their associated schemes. Certifiers can only access data from their associated filters and not the full scheme.

This list provides an overall look at validation warnings by ObjectType (e.g. Membership or NonConformance). To look at a specific warning, the errorID can be passed into the site URL as the warningID like so: https://api.casi.services/v1/schemes/{scheme}/validation/bywarning/{warningid}.eb